home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / cat3 / GetCapStyl.3 < prev    next >
Text File  |  1994-09-20  |  3KB  |  133 lines
  1.  
  2.  
  3.  
  4. Tk_GetCapStyle(3)     Tk Library Procedures
  5.  
  6.  
  7.  
  8. _________________________________________________________________
  9.  
  10. NAME
  11.      Tk_GetCapStyle,  Tk_NameOfCapStyle   -   translate   between
  12.      strings and cap styles
  13.  
  14. SYNOPSIS
  15.      #include <tk.h>
  16.  
  17.      int
  18.      Tk_GetCapStyle(_i_n_t_e_r_p, _s_t_r_i_n_g, _c_a_p_P_t_r)
  19.  
  20.      char *
  21.      Tk_NameOfCapStyle(_c_a_p)
  22.  
  23. ARGUMENTS
  24.      Tcl_Interp   *_i_n_t_e_r_p   (in)      Interpreter  to   use   for
  25.                                       error reporting.
  26.  
  27.      char         *_s_t_r_i_n_g   (in)      String containing  name  of
  28.                                       cap     style:    one    of
  29.                                       ```butt'',  ``projecting'',
  30.                                       or ``round''.
  31.  
  32.      int          *_c_a_p_P_t_r   (out)     Pointer  to   location   in
  33.                                       which  to store X cap style
  34.                                       corresponding to _s_t_r_i_n_g.
  35.  
  36.      int          _c_a_p       (in)      Cap style: one of  CapButt,
  37.                                       CapProjecting, or CapRound.
  38. _________________________________________________________________
  39.  
  40.  
  41. DESCRIPTION
  42.      Tk_GetCapStyle places in *_c_a_p_P_t_r the X cap style correspond-
  43.      ing to _s_t_r_i_n_g.  This will be one of the values CapButt, Cap-
  44.      Projecting, or CapRound.  Cap styles are typically used in X
  45.      graphics  contexts  to  indicate how the end-points of lines
  46.      should be capped.  See the X documentation  for  information
  47.      on what each style implies.
  48.  
  49.      Under normal circumstances the return value  is  TCL_OK  and
  50.      _i_n_t_e_r_p  is  unused.   If  _s_t_r_i_n_g doesn't contain a valid cap
  51.      style or an abbreviation of one  of  these  names,  then  an
  52.      error  message  is  stored  in  _i_n_t_e_r_p->_r_e_s_u_l_t, TCL_ERROR is
  53.      returned, and *_c_a_p_P_t_r is unmodified.
  54.  
  55.      Tk_NameOfCapStyle is the logical inverse of  Tk_GetCapStyle.
  56.      Given  a  cap style such as CapButt it returns a statically-
  57.      allocated string corresponding to _c_a_p.  If _c_a_p isn't a legal
  58.      cap style, then ``unknown cap style'' is returned.
  59.  
  60.  
  61.  
  62.  
  63. Tk                                                              1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. Tk_GetCapStyle(3)     Tk Library Procedures
  71.  
  72.  
  73.  
  74. KEYWORDS
  75.      butt, cap style, projecting, round
  76.  
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129. Tk                                                              2
  130.  
  131.  
  132.  
  133.